jsdoc-parse
Advanced tools
Readme
Transforms jsdoc data into something more suitable for use as template input. Also adds a few tags to the default set:
@category <string>: Useful for grouping identifiers by category.@done: Used to mark @todo items as complete.@typicalname: If set on a class, namespace or module, child members will documented using this typical name as the parent name. Real-world typical name examples are $ (the typical name for jQuery instances), _ (underscore) etc.@chainable: Set to mark a method as chainable (has a return value of this).This module is built into jsdoc-to-markdown, you can see the output using this command:
$ jsdoc2md --json <files>
© 2014-24 Lloyd Brookes <75pound@gmail.com>.
Tested by test-runner. Documented by jsdoc-to-markdown.
FAQs
Transforms jsdoc data into something more suitable for use as template input
The npm package jsdoc-parse receives a total of 106,919 weekly downloads. As such, jsdoc-parse popularity was classified as popular.
We found that jsdoc-parse demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.
Security News
Researchers have demonstrated that teams of LLM agents can exploit zero-day vulnerabilities with a 53% success rate, and the costs of using AI to do so are rapidly becoming more affordable than hiring a human penetration tester.
Security News
In an unprecedented surge, May 2024 saw the publication of over 5,000 CVEs, marking a historic milestone in cybersecurity with an average of 164 CVEs per day, nearly double the 2023 daily average.